home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / PRUS101.ZIP / FCONFIG.DOK < prev    next >
Text File  |  1994-12-19  |  6KB  |  148 lines
  1.                   ////////////////////\\\\\\\\\\\\\\\\\\\\\\\\
  2.                        Dokumentation zu FIDO Unit FCONFIG
  3.                   \\\\\\\\\\\\\\\\\\\\////////////////////////
  4.  
  5.                                  Release 1.00
  6.                                  ^^^^^^^^^^^^
  7.  
  8.   ========================================================================
  9.   Autor: Matthias Tichy, 2:2440/210.14 @ Classic, Düsseldorf 15.08.1994
  10.                          2:2433/920.14 @ Lite
  11.   ========================================================================
  12.  
  13.      1. Config:
  14.      ------------
  15.         Die Unit FConfig.pas stellt Ihnen Routinen zur Verfügung mit denen
  16.         Config-Files gelesen werden können. Diese Config-Files sehen z.B. so
  17.         aus :
  18.  
  19.         -----aha.cfg------
  20.         ; Dies ist ein Kommentar
  21.         Adress 2:2440/210.14 ; hier geben sie ihre Fido-Adresse an
  22.         Adress 100:494/300.18
  23.         [...]
  24.  
  25.         Beispiele dieser Config-Files finden sie bei den Programmen xOR &
  26.         REQMAN, wobei letzteres mit dieser Unit arbeitet.
  27.  
  28.      2. Kurbeschreibung:
  29.      -------------------
  30.  
  31.         CFirst ..........  Kann in ReadEntry statt true zur Übersichtlichkeit
  32.                            eingesetzt werden
  33.         CNext ...........  " statt false
  34.         PConfig .........  Ist ein Record der eine verkettete Liste beginnt
  35.  
  36.         LoadConfig ......  Lädt ein Config-File in den Speicher
  37.         ReadEntry .......  Sucht einen Entry in der Liste
  38.         DisposeConfig ...  Gibt den Speicher des Config-Files frei
  39.  
  40.      3. Detaillierte Beschreibung:
  41.      -----------------------------
  42.  
  43.         ===============================================================
  44.         LoadConfig
  45.         ---------------------------------------------------------------
  46.         ERSTDATUM    ...  23.11.1994    LETZTE ÄNDERUNG ...  30.11.1994
  47.  
  48.         MODIFIKATION ...
  49.         ---------------------------------------------------------------
  50.  
  51.         BESCHREIBUNG ...  Liest ein Config-File in den Speicher ein.
  52.  
  53.         DEKLARATION  ...  LoadConfig(name : string) : PConfig;
  54.  
  55.         PARAMETER    ...  name : Name des Config-Files xxxxxxxx.xxx
  56.  
  57.         ERGEBNIS     ...  PConfig : Pointer auf verkettete Liste, die
  58.                                     die Anderen Routinen benutzen.
  59.  
  60.         ===============================================================
  61.         ReadEntry
  62.         ---------------------------------------------------------------
  63.         ERSTDATUM    ...  23.11.1994    LETZTE ÄNDERUNG ...  30.11.1994
  64.  
  65.         MODIFIKATION ...
  66.         ---------------------------------------------------------------
  67.  
  68.         BESCHREIBUNG ...  ReadEntry sucht in der übergebenen Liste nach
  69.                           einem Entry und speichert diesen in entry.
  70.                           ReadEntry liefert den String der im Config-File
  71.                           steht _ohne_ den Entry-Namen zurück.
  72.  
  73.         DEKLARATION  ...  readEntry(var entry : string;Conf : PConfig;first : boolean) : Integer;
  74.  
  75.         PARAMETER    ...  entry : Entry nach dem gesucht wird. Suche ist
  76.                                   case-INsensitive
  77.                           Conf  : Pointer auf Liste in der gesucht werden soll
  78.                                   dadurch ist es möglich mehrere Listen gleich-
  79.                                   zeitig im Speicher zu halten.
  80.                           first : true  - Es wird von Anfang der Liste gesucht.
  81.                                   false - Es wird das nächste Element gesucht
  82.                                           trotzdem muß Entry neu gesetzt werden.
  83.  
  84.         ERGEBNIS     ...  Entry   : enthält den String nach entry-name im
  85.                                     config-File.
  86.                           Integer : bei  0 alles o.k.
  87.                                     bei -1 den Entry nicht gefunden.
  88.  
  89.         ===============================================================
  90.         DisposeConfig
  91.         ---------------------------------------------------------------
  92.         ERSTDATUM    ...  23.11.1994    LETZTE ÄNDERUNG ...  30.11.1994
  93.  
  94.         MODIFIKATION ...
  95.         ---------------------------------------------------------------
  96.  
  97.         BESCHREIBUNG ...  Löscht die Liste aus dem Speicher.
  98.  
  99.         DEKLARATION  ...  DisposeConfig(var conf : PConfig);
  100.  
  101.         PARAMETER    ...  conf : Config-Liste, die aus dem Speicher gelöscht
  102.                                  werden soll.
  103.  
  104.         ERGEBNIS     ...  keine
  105.  
  106.      4. Beispiele:
  107.      -------------
  108.         ===============================================================
  109.         LoadConfig, ReadEntry, DisposeConfig
  110.         ---------------------------------------------------------------
  111.  
  112.         -----aha.cfg------
  113.         ; Dies ist ein Kommentar
  114.         Adress 2:2440/210.14 ; hier geben sie ihre Fido-Adresse an
  115.         Adress 100:494/300.18
  116.         [...]
  117.  
  118.         var
  119.           Conf : PConfig;
  120.           entry : string;
  121.  
  122.         begin
  123.           Conf := loadConfig('aha.cfg');
  124.           entry := 'Adress';
  125.           if ReadEntry(entry, conf, CFirst) = 0 then
  126.             writeln('MAIN AKA > ', entry)
  127.           else writeln('Entry Adress fehlt im Config-File!');
  128.           Entry := 'Adress';
  129.           while ReadEntry(entry, conf, CFirst) = 0 do
  130.             begin
  131.               writeln('AKA > ', entry);
  132.               Entry := 'Adress';
  133.             end;
  134.             DisposeConfig(Conf);
  135.         end;
  136.  
  137.      5. History:
  138.      -----------
  139.  
  140.         Neuerungen nach Release ...
  141.         ---------------------------
  142.         Noch nischts :-)
  143.  
  144.   ========================================================================
  145.  
  146.                  /////////////////////\\\\\\\\\\\\\\\\\\\\\\\\
  147.                   Ende der Dokumentation zur FIDO Unit FCONFIG
  148.                  \\\\\\\\\\\\\\\\\\\\\////////////////////////